home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / drtrk107.zip / DOORTRAK.DOC < prev    next >
Text File  |  1993-03-22  |  7KB  |  248 lines
  1.  
  2.  
  3.                 DOORTRAK v1.7
  4.  
  5.                 By Wayne Gay
  6.                Thee Landing Z*O*N*E BBS
  7.                   256:101/2@MXBBSNET (NEC)
  8.                    1:3401/5@FIDONET
  9.                   1-206-336-5915(bbs)
  10.                 14.4 v32bis MNP 
  11.                  Mt. Vernon, Washington
  12.  
  13.  
  14.  
  15. Description:
  16.  
  17.     Doortrak is a simple program. It will keep track of the number 
  18.     of times a door is entered. Also it will keep track of door users
  19.     and how many doors they have entered.
  20.     It does this with a call from the door calling batchfile.
  21.     Has been tested using the Xtern_dos and the Xtern_erlvl calls from
  22.     Menus.ctl.
  23.     Doortrak is not limited to doorgames! It can be used to trak any 
  24.     drop from the BBS to a door. IE: Timebanks, Callback Verifiers,
  25.     or any other program that is called from Maximus's menus.ctl using 
  26.     the xtern_???? formats...
  27.  
  28.  
  29. Setup: NEW
  30.  
  31.     Setup is fairly simple. I will try to give examples where possible.
  32.  
  33.     First thing you'll need to do is edit the DOORTRAK.CFG to your suit
  34.     your needs. The Sample included in this archive explains the setup
  35.     for the configuration.
  36.  
  37.     In the directory with DOORTRAK Type : DOORTRAK SETUP
  38.  
  39.     SETUP PROGRAM: is now automated with the doortrak.cfg file...
  40.  
  41. Setup: UPGRADE
  42.  
  43.        You can upgrade doortrak v1.06 with this version(v1.07) without loss 
  44.        of data from the data files, most of the time(see doortrak.sam 
  45.        for details). 
  46.        
  47.        1) UNarj the drtrk107.arj file Over the old files!
  48.       ( The Sample .cfg file is now called doortrak.sam.
  49.         This will preserve your old .cfg for editing )
  50.        
  51.        2) READ THE DOORTRAK.SAM file. This is where you'll find most of the
  52.       new changes!! It won't work with the old .cfg setup!!!
  53.        
  54.        3) If your multinode, you'll need to go into the .bat files for the 
  55.       doors and change the 2nd argument according to the multinode
  56.       setup in a later section.
  57.  
  58.  
  59.  
  60.  
  61.  
  62. Usage:
  63.  
  64.     Using the program is almost as simple as the setup.
  65.     
  66.     Doortrak Defaults to lastuser.bbs. This is created only on 
  67.     single node bbs's. If you have more than One Node of Maximus
  68.     Running then you must use the Multinode paramaters, because
  69.     Maximus will create lastus00.bbs for node one instead. Even if you 
  70.     only plan to use this for one of the nodes and not all.
  71.     
  72.     
  73.    Using the Xtern_Dos exit from Maximus:
  74.  
  75.     In the batch file for the door, either before the door is run or 
  76.     after it's done running Change the current directory to the directory
  77.     with doortrak.exe.
  78.     then call doortrak with the door code as the paramater, 
  79.     
  80.     IE: ( door calling batch file example )
  81.  
  82.     ...... 
  83.     
  84.     cd \rgdoor         ( change to the door directory )
  85.     rgdoor             ( run the door )
  86.     cd\bbs             ( change to the directory doortrak is in )
  87.     doortrak rgd       ( Run DOORTRAK with "rgd" as the paramater )
  88.     or for Multinode
  89.     doortrak rgd 05    ( Run DOORTRAK with "rgd" as the paramater, for 
  90.                  node 6 ) 
  91.     ......             ( go on to bbs )
  92.      
  93.  
  94.    Using the Xtern_erlvl exit from Maximus:
  95.  
  96.     In the bbsbatch file you need to call DOORTRAK in the door subroutine
  97.     either before or after the door is run.
  98.      
  99.     IE: ( bbscalling batch file example )
  100.  
  101.     ......
  102.  
  103.     :rgdoor            
  104.     cd\rgdoor          ( change to the door directory )
  105.     rgdoor             ( run the door )
  106.     cd\bbs             ( change to the directory doortrak is in )
  107.     doortrak rgd       ( Run DOORTRAK with "rgd" as the paramater )
  108.     or for Multinode
  109.     doortrak rgd 05    ( Run DOORTRAK with "rgd" as the paramater, for 
  110.                  node 6 ) 
  111.     ......             ( go on to bbs )
  112.  
  113.  
  114.  
  115. Bulletin Maker:
  116.  
  117.     The bulletin maker can be run after each door or in the nightly 
  118.     maint. ( I suggest the nightly, but it's up to you ).
  119.  
  120.     After Each Door is Run:
  121.  
  122.     Simply run DOORTRAK with the bulletin paramater after the call 
  123.     with the door code.
  124.     
  125.     IE:
  126.     .....
  127.     doortrak bulletin
  128.     ..... 
  129.  
  130.     !!REMEMBER!! This creates a MECCA style file. To View it in Maximus,
  131.     you'll need to compile it with MECCA.
  132.  
  133.     In The Nightly Maint.:
  134.  
  135.     Simply change to the directory DOORTRAK is in, and run DOORTRAK 
  136.     with the bulletin paramater. 
  137.     
  138.     IE:
  139.     .....
  140.     cd\bbs           
  141.     doortrak bulletin
  142.     mecca c:\bbs\misc\bulletin.mec
  143.     ..... 
  144.  
  145.  
  146. Resetting the Counters:
  147.  
  148.     This will clear the counters for the doors as well as the users.
  149.     it will ask you if you really want to do it before it will clear 
  150.     them.
  151.     This feature is for those of us who want to reset them on a monthly
  152.     basis.( Or weekly or whenever..)
  153.  
  154.     IE:     ( Example call to reset the counters )
  155.  
  156.     doortrak reset
  157.  
  158.  
  159.     .....     !!!  NEW feature  !!!!
  160.  
  161. Adding doors:
  162.  
  163.        This feature will allow you to add new doors to the existing list,
  164.        without losing data on the old doors. No more need to reset 
  165.        everything to add new doors to the list.
  166.  
  167.        All you need to do is add the door information( as stated above )
  168.        to the "END" of the list of doors in your doortrak.cfg file.
  169.        Make sure the new doors follow the old doors. You can add as many
  170.        as you'd like up to the maximum.
  171.        Once you've added the proper lines to the .cfg file then type:
  172.        
  173.        doortrak dooradd
  174.  
  175.        Thats all there is to it...
  176.  
  177. Multinode Usage:
  178.  
  179.  
  180.     
  181.     Doortrak is now usable for multi-node BBS's on all nodes using 
  182.     Maximus.
  183.     To use it on a multinode bbs, simply set it up as usual for 1 node,
  184.  
  185.     then from node 1 Use :  DOORTRAK ??? 00
  186.                      ^^^ ^^
  187.                      ^^^ ^^ 2 digit node number(in hex)
  188.                      ^^^
  189.                      ^^^ 3 digit doorcode
  190.  
  191.     then from node 2 Use :  DOORTRAK ??? 01
  192.                      ^^^ ^^
  193.                      ^^^ ^^ 2 digit node number(in hex)
  194.                      ^^^
  195.                      ^^^ 3 digit doorcode
  196.     ...
  197.     ...
  198.     ...                                  
  199.                          
  200.     then from node 9 Use :  DOORTRAK ??? 08
  201.                      ^^^ ^^
  202.                      ^^^ ^^ 2 digit node number(in hex)
  203.                      ^^^
  204.                      ^^^ 3 digit doorcode
  205.  
  206.     The 2 digit node number must be in hex format! 
  207.     IE: node #1 is 00 : node #16 is 0f : Node #24 is 17
  208.     and it MUST be 2 digit!!!
  209.     
  210.     This paramater is only used for the counting portion of the 
  211.     program, so it is only used when you use the doorcode paramater. 
  212.     It must always be the 2nd argument, following the 3 digit code.
  213.  
  214.     This option creates 1 bulletin, and 1 data file only. It doesn't
  215.     create seperate bulletins for each node or keep track of use by 
  216.     node. Only totals of all nodes.
  217.  
  218.  
  219. Limitations:
  220.  
  221.     This program is currently capable of handling up to 100 doors
  222.     and 1000 users. I expect this to be large enough. Don't worry if
  223.     you have more than 1000 users, unless they all use the doors,
  224.     The program only adds the doorusers names to the database as 
  225.     they use them, without duplicating any of them.
  226.  
  227. Registration:
  228.  
  229.     Since I put my time into the building and ever improving of this
  230.     program, I feel a small fee should be payed for it's continued
  231.     use. So I ask you to send me $5.00, in return, I'll send you a
  232.     registration key, which will show registered in the bulletin, as
  233.     well as enable the function to adjust the length of the bulletin.
  234.  
  235.  
  236. Please report all bugs to me via netmail at the addresses above.
  237.  
  238.  
  239. ANY SUGGESTIONS for the improvement of this program will be gladly looked 
  240. into. 
  241.  
  242. Enjoy (I hope) this program....
  243.  
  244.  
  245. Thanks to Brian Pirie for the use of his Registration Key System Version 2.20
  246.  
  247. Maximus is a product from Scott Dudley ( Thanks!! )
  248.